@jsbits/get-package-version

@jsbits/get-package-version

Part of the JSBits suite.

Get the version of the package.json file found in the given directory or in one of its parents.

Install

For NodeJS and JS bundlers:

npm i @jsbits/get-package-version
# or
yarn add @jsbits/get-package-version

Targets

• NodeJS v4.2 or later

getPackageVersion([pkgPath]) ⇒ string

Returns the version of the first package.json file found in the given directory or in one of its parents.

• If you don't provide a path, the search starts in the current one.
• The provided path can be relative to the current working directory.
• Packages with a missing or empty version property are ignored.

Param	Type	Default	Description
[pkgPath]	string	"."	Initial directory to search, defaults to process.cwd().

Returns: string - The package version, or an empty string if it could not be found.

Since 1.0.0
Group: dev
Author/Maintainer: aMarCruz

Example

import getPackageVersion from '@jsbits/get-package-version'

const version = getPackageVersion() // ⇒ '1.0.0' (just as example)

Imports

All the JSBits functions works in strict mode and are compatible with:

• ES5 browsers, through the jQuery $.jsbits object or the global jsbits.
• ESM Bundlers, like webpack and Rollup.
• ES modules for modern browsers or NodeJS with the --experimental-modules flag.
• CommonJS modules of NodeJS, jspm, and others.
• Babel and TypeScript, through ES Module Interop.

Please see the Distribution Formats in the JSBits README to know about all the variants.

Support my Work

I'm a full-stack developer with more than 20 year of experience and I try to share most of my work for free and help others, but this takes a significant amount of time and effort so, if you like my work, please consider...

Of course, feedback, PRs, and stars are also welcome 🙃

Thanks for your support!

License

The MIT License.

© 2018-2019 Alberto Martínez – Readme powered by jscc and jsdoc-to-markdown